This folder contains various sample part editors, the Container Application Library (CALib), PartMaker, and OpenDoc Scripting examples.
PartMaker 4.4
PartMaker is a template part editor generator; meaning that it will create a folder hierarchy with sources and build support for a part editor. It is extremely useful for creating a working body of code from which to start your part development. Template documents are provided for the sample parts also provided on this CD.
Scripting
This folder contains some useful information and template classes for developers wishing to add scripting support to their parts.
CALib & You…
CALib is provided to allow standard Macintosh applications to be more easily modified to allow embedding of OpenDoc parts.
Sample Editors/Viewers
This folder contains lots of OpenDoc part development examples. The samples are updated versions of the SamplePart (in C and C++), Picture viewer, Text editor, Drawing editor, and Sound editor, and 3 new parts: Cappuccino, Panel editor, and Script Runner . Each main implementation file (in the case of SamplePart, SamplePart.cpp) details the recipes and functionality that the part demonstrates. For more detailed descriptions of the sample parts, please refer to the “About Sample Code Parts” document found in the “Sample Editors/Viewers” folder.
We hope all the samples give you a place to start and are useful in getting you started with OpenDoc part editor development.
[Please note the warnings listed at the end of this document]
Getting Started
Building any of the sample parts is easy, though you must have first set up your build environment as prescribed in the “Development” folder installation documents. Once you have your preferred build environment installed, copy the part you wish to work with to your local drive (perhaps inside your development folder).
In the MPW® environment, all samples share a single build system. The build system relies on the UserStartup•OpenDoc script to provide the necessary information for the MPW environment. For other environments, refer to the "setup" documentation provided elsewhere on the CD. In any case, the environment will need to locate the "OpenDoc" folder.
Each sample contains project sources and interfaces in a “Sources” folder, an output folder for the object files called “Objects”, an optional folder for System Object Model™ (SOM) support/source files (named “_SOM_” in the SamplePart example), and projects, or a makefile, for supported enviornments.
To build a sample, make sure you have installed the necessary support files. To do this, open the "Development Additions" folder and follow the instructions provided.
Most Notable Changes
The parameters and use of the build script has been enhanced/changed from the DR3 version. The script now requires that you specify the compilers you wish to build with differently. This done with the -b command. Also, as part of the continued "genericizing" effort, the FAT library build rules have been moved out into the build system (see SamplePart.make for the latest makefile layout). In addition, a "non debug" option has been added to produce "final" binaries (the option is -noDBG).
Makefiles for the sample parts have been enhanced to take advantage of some newer requirements and build system enhancements. All tools used in the build process are now substituted at "make time" through variables defined in the build system. The link lines now specify CFM version numbers. The source dependency rules now specify the precompiled header. The OpenDoc utilities dependency rules are part of the build system/support.
Building 68k Parts in MPW Pro
To build a sample part in MPW...
1) Launch the MPW Shell application.
2) Set the current directory to your local copy of the sample you are building.
Directory 'Macintosh HD:MPW:SamplePart (C++):'
3) Run the build script for the sample providing one of several build options.
BuildOpenDocPart -f ":SamplePart.make" -b SCpp
The build script supports building parts with both the Symantec 68k C++ compiler and MrC/Cpp. The build script also drives the SOM compiler, and the Rez tool for the sample parts.
The following (monaco) text outlines the scripts usage.
(Note: If you run the BuildSampleCode script with no parameters, it will provide you with the information provided above)
To adjust the individual compiler options, you merely need to locate the appropriate variable makefile in the “Build Support” folder for the compiler. Each compiler has its own variables makefile. (e.g. The Symantec™ SCpp compiler options file is named SCppVars.make).
Building PPC Parts in MPW Pro
There is no difference from building parts for 68k, except that you must specify a PowerPC compiler when executing the BuildOpenDocPart script.
BuildOpenDocPart -f ":SamplePart.make" -b MrCpp
Building PPC Parts in an Integrated Development Environment (IDE)
(eg. CodeWarrior, Symantec 8.0)
To build a sample part in an IDE...
1) Launch the project for the sample.
2) If necessary, update the project so that it can locate the "Build Support" folder you previously installed.
3) Save preference changes.
4) Build the project.
If you need to make changes to a sample's IDL file, .r file, or resource (.rsrc) file, you will need to have the MPW environment installed (unless your IDE supports build those). The IDL build can only be driven from MPW using the provided build script as described above.
Using MrC/Cpp [E.T.O./MPW Pro Subscribers ]
This version of the build system supports MrC/Cpp 1.0f1 (or later) and the PPCLink 1.3 (or later) tool. See the “SamplePart.make” makefile for an example of a PPC link line supporting MrC/Cpp. Both tools will be/are available on E.T.O #18 (and later).
Note that you will need to set your MPW Shell partition to (at least) 8mb and you must have (at least) 12mb of temp mem available when you do a build. If you get really weird errors, try giving MPW more memory and/or freeing up more temp mem.
Running Built Editors
Once you've built your part editor, you will obviously want to run it. For information on running and using part editors, refer to the Tech Notes in the “Documentation” folder at the root level of this CD.
Debugging Part Editors
There is a worthwhile discussion on the ins/outs of debugging in the CFM runtime environment in the “Debugging OD Part Editors” in the “Debugging OpenDoc” folder.
Example Part Resources
A ResEdit file of example part cursors, icons, thumbnails, and an about box has been provided for use with the parts you create. The file includes all cursors not available from the System for use with parts, a sampling of various document and editor icon suites, as well as a smattering of thumbnail samples, a generic about box, and most of the patterns needed to implement various OpenDoc specific borders/highlighting.
The resources in the file were used in creating the sample code parts.
• All builds rely on having built resource files in the PPC & 68k objects folders. If the files are destroyed or removed from those folders, be sure to run the MPW build for the sample using the -b rez option; this will regenerate the resource files for both the PPC and 68k builds.
